home *** CD-ROM | disk | FTP | other *** search
/ CD Ware Multimedia 1994 November / Cd Ware (Nro. 2) - Epimundo.iso / DOS / CM / QSOGATE.ZIP / QSOGATE.DOC < prev    next >
Encoding:
Text File  |  1994-05-21  |  18.1 KB  |  409 lines

  1.      ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄      ▒▒▒▒▒▒▒▒▄
  2.      ▒▒█▀▒▒█ ▒▒█▀▀▀▀ ▒▒█▀▒▒█      ▒▒█▀▀▀▀▀▀
  3.      ▒▒█ ▒▒█ ▒▒▒▒▒▒▄ ▒▒█ ▒▒█      ▒▒█       ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄
  4.      ▒▒█▒▒▒█  ▀▀▀▒▒█ ▒▒█ ▒▒█      ▒▒█ ▒▒▒▒▄ ▒▒█▀▒▒█  ▀▀▒▒█▀▀▀ ▒▒█▀▀▀▀
  5.      ▒▒▒▒▒▒█ ▒▒▒▒▒▒█ ▒▒▒▒▒▒█      ▒▒█  ▀▒▒█ ▒▒▒▒▒▒█    ▒▒█    ▒▒▒▒▄
  6.       ▀▀▒▒█▀  ▀▀▀▀▀▀  ▀▀▀▀▀▀      ▒▒█   ▒▒█ ▒▒█▀▒▒█    ▒▒█    ▒▒█▀▀
  7.       (c) Copyright 1993-94       ▒▒▒▒▒▒▒▒█ ▒▒█ ▒▒█    ▒▒█    ▒▒▒▒▒▒▄
  8.      Modern BBS Development        ▀▀▀▀▀▀▀▀  ▀▀  ▀▀     ▀▀     ▀▀▀▀▀▀
  9.  
  10.  
  11.   * FIRST TIME USERS OF QSOGATE: Please be sure to read the file called
  12.     HISTORY.DOC once you have browsed this DOC file. The HISTORY.DOC file
  13.     contains latest info on changes and additions to QSOGATE that are not
  14.     mentioned in this file.
  15.  
  16.   (Please see HISTORY.DOC and UPDATE.DOC for latest info BEFORE installing)
  17.  
  18.                               * Description *
  19.  
  20.     QSO Gate is a utility that enhances the operation of eSoft's QSO and
  21.     also provides a nice interface for tagging conferences. QSOGate also
  22.     allows you to read/write messages from the TBBS message base and also
  23.     will allow reading of PcBoard 14.5 message bases on-line.
  24.    * (See notice at bottom of this file for info on PcBoard 14.5 bases)
  25.  
  26.   √ Enhanced message area listing with ability to list NETWORK, and a brief
  27.     description for EACH entry!
  28.  
  29.   √ High speed 'select' utility that allows using methods such as #-# or
  30.     single entries such as # or #,#,#  or even #,#-#,#,#-# !
  31.  
  32.   √ The MAIN MENU of QSO Gate is YOURS! You are free to make it look any
  33.     way you like, and to go one step further.... you can place any key
  34.     and TBBS/TDBS entry type on the screen too! QSO Gate only holds the
  35.     rights to key 1 and key 2, which are ENTER QSO and SELECT CONFERENCES
  36.     respectively. Using the QSOGate.Ctl file, you can define ANY key entry
  37.     to do things like:
  38.  
  39.       1) let user return to last calling menu
  40.  
  41.             KEY=-
  42.             TYPE=12
  43.             OPT DATA=1
  44.  
  45.       2) allow user to use ASR's QWKFIX to upload reply packets
  46.  
  47.             KEY=U
  48.             TYPE=200
  49.             OPT DATA=C:\Tbbs\QwkFix\QwkFix /q
  50.  
  51.       3) allow user to download help file for QSO
  52.  
  53.             KEY=D
  54.             TYPE=1
  55.             OPT DATA=C:\Qso\QsoHelp.Doc /D
  56.  
  57.       4) or let the user log off using your logoff menu!
  58.  
  59.             KEY=G
  60.             TYPE=5
  61.             OPT DATA=BYE
  62.  
  63.    NOTE: Software, especially on-line applications, need to be stamped
  64.          with a Copyright Notice. We feel that letting the MAIN MENU be
  65.          yours for design is better than making it to our liking. So, in
  66.          order to comply with that methodology, we placed the Copyright
  67.          stamp 'on the way out' of QSO Gate into QSO. There is ZERO delay
  68.          to display this notice, so the only delay that is felt is the
  69.          actual process time of QSO Gate to generate a custom INCLUDE
  70.          file, drop it, and close all datafiles.
  71.  
  72.   √ QSO Gate comes with QGate.Exe, which is an off-line utility that is the
  73.     heart and soul of setup. Using that, and the Ctl2Gate.Exe utility, you
  74.     can mass import your qso.ctl file. After the import, enter Qgate.Exe,
  75.     and make all the adjustments you need to make including authorizations
  76.     using the users PRIV, A1, A2, A3, A4 or even LINE considerations!
  77.     Qgate.Exe even comes with a high speed "Mass Update" feature that allows
  78.     you to change a whole group of records with only a few keystrokes!
  79.  
  80.   √ Advanced datafile structures! QsoGate keeps a 'ptr' file with a 1k BINARY
  81.     entry for each user. Their conference selections are stored here until you
  82.     squeeze the QsoUser.Log file for age.. or until he makes changes. Using
  83.     the QsoGate.Ctl file, you are able to store your defined MAIN MENU key
  84.     entries and have them read on the fly. With limited use of "resource
  85.     draining" programming engines, QSO Gate is very considerate of your
  86.     system in respect to impact.
  87.  
  88.  
  89.                                 * Purpose *
  90.   QSO Gate was written with one initial intent. With the latest outbreak of
  91.   TBBS satallite installations, everyone seems to want to make 4700 or more
  92.   conferences available via QSO, naturally. After discovering some of the
  93.   limitations QSO and TBBS impose due to the multi-user environment, a
  94.   'front door' type utility was in demand. Some of these limitations are as
  95.   follows:
  96.  
  97.            1) Not more than 1500 conferences can safely be defined in the
  98.               QSO.Ctl file when using the QsoExtern.Ctl file. This limits
  99.               the use of PcBoard style (EXTERNAL) message bases.
  100.  
  101.            2) When using 1500-1800 conferences, a user may have to withstand
  102.               a 3 to 10 minute run time load period. They are better off
  103.               reading on-line! :-)
  104.  
  105.            3) When a user enters the "Select Conferences" function, QSO
  106.               displays a list of available areas. When running with any more
  107.               than 300 or more msg areas, a user can/will find it hard to
  108.               understand what each entry is suposed to be due to the
  109.               truncation of of the MSGAREA definition to only 12 characters,
  110.               and there is no way to descibe what each entry is.. nor can
  111.               the user tell where the message originates... FidoNet, RIME,
  112.               SeekNet, Internet, ThrobNet, etc...
  113.  
  114.   QSO Gate addresses these problems directly by first, making the user enter
  115.   the QSO module THROUGH QSO Gate, letting the user select conferences from
  116.   a list that shows him the Conference NAME, DESCRIPTION, And NETWORK all in
  117.   an ergonomic style. If the user has a Conference selected, it is clearly
  118.   denoted with a √ next to the conference. When the user is finished making
  119.   his choices, he enters QSO with a CUSTOM CTL file that is loaded JUST FOR
  120.   HIM! No longer will QSO have to crunch through 5000 conferences... it will
  121.   just be expected to load THAT user's list, which is ONLY what he selected,
  122.   normally between 10 and 50!! QSO Gate keeps a record for each user so that
  123.   the selections are saved for the next call(s).
  124.  
  125.   NOTE:
  126.   QSO Gate is a TDBS utility that clearly demostrates the power of TBBS/TDBS
  127.   and QSO working together. In no way does QSOGate take the place of QSO nor
  128.   does it compete with the excellent software mechanics of eSoft's QSO module.
  129.   QSO Gate is meant only to enhance it's operation and appearance.
  130.  
  131.  
  132.                    * Setup Instructions & Information *
  133.  
  134.   Please follow these instructions CAREFULLY. We recommend that you read ALL
  135.   the instructions first, and then come back and follow each step in order.
  136.  
  137.   STEP 1)
  138.      Make a directory for QSOGate to live in. EX: C:\QGate
  139.      Place all of the files from the QSOGATE.ZIP archive into this
  140.      directory.
  141.  
  142.   Step 2)    (If you are NOT already running QSO, go to step 3)
  143.      The very next thing now is to make a copy of your QSO.CTL file into
  144.      your QsoGate directory. If you are just setting up eSoft's QSO for the
  145.      first time, create your QSO.Ctl according to your needs as instructed
  146.      in the QSO manual.
  147.  
  148.      When you have a copy of the QSO.Ctl file in your C:\QGate directory,
  149.      edit the file to include only MSGAREA and RESTRICT statements. Delete
  150.      EVERYTHING ELSE! Only lines that either start with the work 'MSGAREA' or
  151.      'RESTRICT' or 'ENDRESTRICT' will be valid. Anything else in this file
  152.      that is not commented out using the ';' will cause setup interference.
  153.      EXAMPLE:
  154.  
  155.      ; Comment Line, this will be ignored.
  156.      MSGAREA   1x       TBBS          "TBBS"            FIDONET
  157.      MSGAREA   2x       WINDOWS       "WINDOWS"         FIDONET
  158.      RESTRICT A1=-------X A3=X..X.... Priv=200
  159.         MSGAREA   3x       CUSTOMERS     "CUSTOMERS"    LOCAL
  160.      ENDRESTRICT
  161.  
  162.      NOTE: This file is VERY strict in it's format. It complies with the
  163.      normal QSO setup 100%! You must have the following items defined for
  164.      the Ctl2Gate program to work properly:
  165.  
  166. MSGAREA  <msgID##><attributes>  <qwk name>   <msg base name>   <networkID>
  167.  
  168.      Even if you never used a NETWORK ID statement before, edit the file to
  169.      now include one. Use 'LOCAL' for non network msg areas or something
  170.      similiar.
  171.  
  172.      Now run Ctl2Gate.Exe and this will mass import the edited QSO.CTL
  173.      file into the QSOGate.DBF file and build its indexes.
  174.  
  175.   STEP 3)
  176.      Run the QGate.Exe program. This program is very user friendly and allows
  177.      you to edit each area for things like PRIV level, flags, etc. Once you
  178.      make all the necessary changes to the actual database of entries, it
  179.      is now time to do the on-line installation.
  180.  
  181.   STEP 4)
  182.      If you already have QSO installed on your system, simply replace the
  183.      menu entry with the following info. If you do not have QSO installed,
  184.      make a menu entry like the following to access it...
  185.  
  186.           ENTRY:
  187.           Key=Q  Type=5  Opt Data=GATE
  188.  
  189.     This will call the following menu you will create next. Now, make the
  190.     following menu and compile it and place it into your menu????.ctl
  191.     directory (where all your menus are). You can clip this out and use it
  192.     or make your own.....
  193.  
  194.           Menu: GATE
  195.  
  196.           Entry:
  197.           Key=^@
  198.           Type=200   Opt Data=C:\QGate\QsoGate /q -C:\Tbbs
  199.  
  200.           Entry:
  201.           Key=^@
  202.           Type=45     Opt Data=GATE
  203.  
  204.           EndMenu:
  205.  
  206.  
  207.      Note the trailing 'C:\Tbbs' in the call to QSO Gate Entry in menu GAT1.
  208.      This is a path to TBBS so that QsoGate can access the REAL QSO.Ctl file
  209.      which is where this file should be. If you don't include this, QsoGate
  210.      will look for it in the C:\Tbbs directory by default.
  211.  
  212.   STEP 5)
  213.      Edit the menu and display files. Using TheDraw or something similiar,
  214.      edit the GateMain.Ans and GateMain.Asc files. These are your MAIN menus
  215.      for when you enter QSO Gate. You must have at least three entries in
  216.      this file for operation. One key for entrance into QSO, one to select
  217.      conferences, and one to allow the user to exit the program back to
  218.      the calling menu. You can use many methods, but the recommended way to
  219.      to send the user back to the calling menu (out of the program) is by
  220.      using the following entry in the QsoGate.Ctl file:
  221.  
  222.      KEY=Q
  223.      TYPE=12
  224.      OPT DATA=1
  225.  
  226.      The QSOGATE.CTL file is for defining keys that are used on the main menu.
  227.      The format is VERY STRICT, which was done to allow for HIGHEST SPEED.
  228.      All CHARACTERS ARE CaSe SeNsItIvE! They must all be in CAPS, and the
  229.      format is:
  230.  
  231.      KEY=<char>
  232.      TYPE=<num>
  233.      OPT DATA=<string>
  234.  
  235.      for example:
  236.  
  237.      KEY=1
  238.      TYPE=999
  239.      OPT DATA=QSO
  240.  
  241.      KEY=2
  242.      TYPE=999
  243.      OPT DATA=SELECT
  244.  
  245.      KEY=3
  246.      TYPE=200
  247.      OPT DATA=C:\QGate\QwkFix /q
  248.  
  249.      KEY=G
  250.      TYPE=5
  251.      OPTDATA=BYE
  252.  
  253.      All entries are to be seperated by a single line, generated by simply
  254.      hitting ENTER.
  255.  
  256.      Note: An entry type 999 is an INTERNAL type and is not related to TBBS's
  257.            menu entries at all. When using a type=999, you must place one
  258.            of three possible commands in the OPT DATA= field. These are
  259.            as follows:
  260.  
  261.            1. OPT DATA=QSO          (Enter QSO)
  262.  
  263.            2. OPT DATA=SELECT       (Select conferences)
  264.  
  265.            3. OPT DATA=READ         (Read/Write messages on-line)
  266.  
  267.  
  268.      *DISPLAY FILES*
  269.  
  270.      NEWUSER.ANS and NEWUSER.TXT are very similiar to QSO's own QSONEW.ANS
  271.      and QSONEW.TXT files, and serve the same purpose. This file is used to
  272.      welcome the user, and explain what they must do, and why they are being
  273.      placed into the CONFERENCE SELECTION function immediately. Actually,
  274.      you could probably use the standard NEWUSER.ANS that is used in QSO
  275.      normally. It has been observed that using two screens will do more to
  276.      help the user understand what is happening so we will use the NEWUSER.*
  277.      to display to a new user on entry to QSO Gate and we will use QSONEW.*
  278.      to show on the way into QSO. A modified QSONEW.* file has been included
  279.      with the release archive and these files, although can be modified,
  280.      should be used in place of the old QSONEW.* files that are now resident
  281.      in your QSO directory. NOTE: See the HISTORY.DOC file for an UPDATE to
  282.      this operation.
  283.  
  284.      You should also edit your qsocfg.ans & qsocfg.txt files that are used
  285.      by QSO itself. There is a key ('C') for 'Conference Select' that you
  286.      will not be able to use any longer on that screen. Also, to aviod any
  287.      "slips of the finger", you should run QSOlang and disable the C key
  288.      that activates that selection. This is done by make it LOWER CASE.
  289.  
  290.      CONFHELP.ANS and CONFHELP.ASC are displayed when a user presses ? when
  291.      at the conferences selection prompt. READHELP.ANS and READHELP.ASC are
  292.      displayed at the READ/WRITE messages prompt.
  293.  
  294.   STEP 6)
  295.      The next step is to edit your REAL QSO.CTL file (NOT one used for mass
  296.      import). You are advised to make a backup copy too. Edit the QSO.CTL
  297.      file to NOT include ANY MSGAREA statements. All that is required to
  298.      be in this file is the basic header info that contains info about the
  299.      system itself and the following:
  300.  
  301.      Add 1 INCLUDE statement for EVERY line on your system. This statement
  302.      consists of an INCLUDE statement and a RESTRICT block.
  303.      This is how the format will be.....
  304.  
  305.      RESTRICT Line=00
  306.          INCLUDE C:\QGate\QsoGate.00
  307.      ENDRESTRICT
  308.  
  309.      RESTRICT Line=01
  310.          INCLUDE C:\QGate\QsoGate.01
  311.      ENDRESTRICT
  312.  
  313.      RESTRICT Line=02
  314.          INCLUDE C:\QGate\QsoGate.02
  315.      ENDRESTRICT
  316.  
  317.      ......etc.
  318.  
  319.      Make one for EACH line on your TBBS System. These are the actual files
  320.      that will tell QSO how to operate for each caller. One glitch that QSO
  321.      has at this time is to check for the existance of EACH INCLUDE file
  322.      that is defined. Even if the caller does not qualify for that file, QSO
  323.      will still check for its existance. So for this, we need to make dummy
  324.      files to keep QSO happy until real users come in and start using QSOGate.
  325.      There is a batch file called Init.Bat in this archive. Edit this .bat
  326.      file to contain only the line definitions that you have lines for. This
  327.      bat file will create the dummy files that are needed. Make sure they
  328.      are created in the QSOGate directory (C:\QGate). Also, make sure that
  329.      the INCLUDE statements are pointing to the files titled QsoGate.##
  330.      and that they are being called FROM the QsoGate directory (C:\QGate) as
  331.      in the above example.
  332.  
  333.      Now, simply run QSOGate and you're set! There is one final part of
  334.      installation that is not mandatory, but is HIGHLY recommended. We've
  335.      included another mass import function to the Qgate.Exe program that
  336.      will mass import descriptions for each area. The way it works is like
  337.      this:
  338.  
  339.      Once selecting to import, you are prompted for a filename to import.
  340.      That file MUST be in the folowing format-
  341.  
  342.      ;<tagname>   <description>
  343.      TBBS         National TBBS Sysop Echo
  344.  
  345.      This format derived from the common FIDOnet.Na file that is available
  346.      from your fido hub. When the process starts, each record in the
  347.      QSOGate database will be searched against this list. Actually, only
  348.      the QWK NAME field will be searched against the list. When a match is
  349.      found, the description will be entered in the description field and you
  350.      are prompted to save or skip this entry. The reason for the prompting is
  351.      so that you can verify that this is the actual description for this
  352.      entry. Now, although this is quite easy, it is very tedious since if
  353.      you are carrying several msg networks, there can be similiar tag names
  354.      that will trigger a match on a search. So you will be prompted to
  355.      verify each match.
  356.  
  357.                        * SYSOP On-Line Operation *
  358.  
  359.      As the SYSOP (priv=255), there is one additional feature that you can
  360.      use. It is called EDIT and will allow you to type EDIT 100 to edit the
  361.      fields of record of record 100 on-line. Other users can not see, nor
  362.      can they use this function.
  363.  
  364.                     * PcBoard 14.5 Message Operation *
  365.  
  366.      To use QSOGate's Reader option, you must first have the following
  367.      statement listed in your QSOGATE.CTL file:
  368.  
  369.      CNAMES=<D:\path>                (path to your existant CNAMES.@@@ file)
  370.  
  371.      It is recommended that you place the CNAMES.@@@ file into the current
  372.      QGATE directory. A copy of this file is fine, as long as it is
  373.      current.
  374.  
  375.      Next, you will need to place the actual CNAMES.@@@ record number of
  376.      each conference in the 'Cnames Rec ##' field within QGATE.EXE.
  377.  
  378.      Lastly, make a directory called \TEMP within your current \QGATE
  379.      directory. This TEMP directory is used to copy the message base and
  380.      index file into so that sharing violation possibility is greatly reduced.
  381.  
  382. ----------------------------------------------------------------------------
  383.          * Notice About PcBoard 14.5 Message Bases And QSOGate *
  384.      The ability to read PcBoard 14.5 message bases within QSOGate was
  385.      provided as a feature enhancement. When you register QSOGate, you will
  386.      not pay for this feature in any way since it is severely limited in
  387.      many ways and Modern BBS will not be able to support this feature at
  388.      all.
  389.  
  390.      The reason for this is simple. You must have a cnames.@@@ file to
  391.      operate in this mode and QSOGate contains NO utilities to create this
  392.      file. You must ALREADY have a cnames.@@@ file installed, and you must
  393.      already have your message bases created and indexed. We can and will
  394.      not provide any assistance in using PcBoard 14.5 message bases.
  395.  
  396.      This is a FREE option and you do not have to use it. It is recommended
  397.      that only advanced SYSOPS challenge this type of setup.
  398. ----------------------------------------------------------------------------
  399.  
  400.      Modern BBS, The BBS Superstore!
  401.      744 Walnut Avenue UNIT 1C
  402.      Bensalem, PA 19020
  403.  
  404.      (215) 638-1424 voice
  405.      (215) 638-1299  data
  406.      fido:       1:273/730
  407.      internet:   rick.kosick@modern-bbs.com
  408.      telnet:     modern-bbs.com
  409.